<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVTX C API Reference: nvtxPayloadEnumAttr_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">NVTX C API Reference<span id="projectnumber">&#160;v3</span>
   </div>
   <div id="projectbrief">NVIDIA Tools Extension Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">nvtxPayloadEnumAttr_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>NVTX payload enumeration type attributes.  
 <a href="structnvtx_payload_enum_attr__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a3210b1a35c305aaef946803cc1ac1317" id="r_a3210b1a35c305aaef946803cc1ac1317"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_enum_attr__t.html#a3210b1a35c305aaef946803cc1ac1317">fieldMask</a></td></tr>
<tr class="separator:a3210b1a35c305aaef946803cc1ac1317"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5731ed1f823e0ff0aac3eeea68c8a6d5" id="r_a5731ed1f823e0ff0aac3eeea68c8a6d5"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_enum_attr__t.html#a5731ed1f823e0ff0aac3eeea68c8a6d5">name</a></td></tr>
<tr class="separator:a5731ed1f823e0ff0aac3eeea68c8a6d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a81abd10a27f81936c78cdafe5a7ab8" id="r_a2a81abd10a27f81936c78cdafe5a7ab8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structnvtx_payload_enum__t.html">nvtxPayloadEnum_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_enum_attr__t.html#a2a81abd10a27f81936c78cdafe5a7ab8">entries</a></td></tr>
<tr class="separator:a2a81abd10a27f81936c78cdafe5a7ab8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a011b55b330f17b2e64157c169fad3880" id="r_a011b55b330f17b2e64157c169fad3880"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_enum_attr__t.html#a011b55b330f17b2e64157c169fad3880">numEntries</a></td></tr>
<tr class="separator:a011b55b330f17b2e64157c169fad3880"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12b15187dd2515a895935a767dfbaac0" id="r_a12b15187dd2515a895935a767dfbaac0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_enum_attr__t.html#a12b15187dd2515a895935a767dfbaac0">sizeOfEnum</a></td></tr>
<tr class="separator:a12b15187dd2515a895935a767dfbaac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac51da0682943b6a5b4fa12365d7f81d4" id="r_ac51da0682943b6a5b4fa12365d7f81d4"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_enum_attr__t.html#ac51da0682943b6a5b4fa12365d7f81d4">schemaId</a></td></tr>
<tr class="separator:ac51da0682943b6a5b4fa12365d7f81d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31e43f2fd232fe218a8810ca2367906f" id="r_a31e43f2fd232fe218a8810ca2367906f"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_enum_attr__t.html#a31e43f2fd232fe218a8810ca2367906f">extension</a></td></tr>
<tr class="separator:a31e43f2fd232fe218a8810ca2367906f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>NVTX payload enumeration type attributes. </p>
<p>A pointer to this struct is passed to nvtxPayloadEnumRegister. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00870">870</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a2a81abd10a27f81936c78cdafe5a7ab8" name="a2a81abd10a27f81936c78cdafe5a7ab8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a81abd10a27f81936c78cdafe5a7ab8">&#9670;&#160;</a></span>entries</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structnvtx_payload_enum__t.html">nvtxPayloadEnum_t</a>* nvtxPayloadEnumAttr_t::entries</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Entries of the enum. (Mandatory) </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00885">885</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a31e43f2fd232fe218a8810ca2367906f" name="a31e43f2fd232fe218a8810ca2367906f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31e43f2fd232fe218a8810ca2367906f">&#9670;&#160;</a></span>extension</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* nvtxPayloadEnumAttr_t::extension</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Flexible extension for enumeration attributes. (Do not use. Reserved for future use.) </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00908">908</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a3210b1a35c305aaef946803cc1ac1317" name="a3210b1a35c305aaef946803cc1ac1317"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3210b1a35c305aaef946803cc1ac1317">&#9670;&#160;</a></span>fieldMask</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxPayloadEnumAttr_t::fieldMask</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Mask of valid fields in this struct. See <code>NVTX_PAYLOAD_ENUM_ATTR_FIELD_*</code>. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00875">875</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a5731ed1f823e0ff0aac3eeea68c8a6d5" name="a5731ed1f823e0ff0aac3eeea68c8a6d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5731ed1f823e0ff0aac3eeea68c8a6d5">&#9670;&#160;</a></span>name</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* nvtxPayloadEnumAttr_t::name</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Name of the enum. (Optional) </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00880">880</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a011b55b330f17b2e64157c169fad3880" name="a011b55b330f17b2e64157c169fad3880"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a011b55b330f17b2e64157c169fad3880">&#9670;&#160;</a></span>numEntries</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxPayloadEnumAttr_t::numEntries</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Number of entries in the enum. (Mandatory) </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00890">890</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="ac51da0682943b6a5b4fa12365d7f81d4" name="ac51da0682943b6a5b4fa12365d7f81d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac51da0682943b6a5b4fa12365d7f81d4">&#9670;&#160;</a></span>schemaId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxPayloadEnumAttr_t::schemaId</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A static payload schema ID must be unique within the domain, &gt;= NVTX_PAYLOAD_SCHEMA_ID_STATIC_START and &lt; NVTX_PAYLOAD_SCHEMA_ID_DYNAMIC_START </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00902">902</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a12b15187dd2515a895935a767dfbaac0" name="a12b15187dd2515a895935a767dfbaac0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12b15187dd2515a895935a767dfbaac0">&#9670;&#160;</a></span>sizeOfEnum</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxPayloadEnumAttr_t::sizeOfEnum</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Size of enumeration type in bytes </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00895">895</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
